Get License Info for Service

The Get License Info for Service request retrieves the details of the applied license factors for a specific service.

URI

Copy 
{{baseUrl}}/api/v3/customer/{customerGuid}/licenseinfo

HTTP Method

GET

Request Parameters

Parameter

Type

Description

umpCustomerGuid

string($uuid)

Id value created in the Live Platformcustomer tenant SQL database directory:

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also obtained in the 'Get Task' response when the customer is created.

nrOfMonths

integer

default: 1

Indicates the number of months for which to retrieve records. Default: 1

Retrieves one record per day.

Example Response

Copy 
[
    {
        "acquiredLicenses": 50,
        "totalMonitoredUsers": 20,
        "currentlyLicensed": 24,
        "managedUsersDirectRouting": 6,
        "managedUsersOperatorConnect": 2,
        "managedUsersByLifeCycleManagement": 4,
        "managedUsersUserInterface": 10,
        "managedServiceNumbers": 2,
        "lastUpdate": "2023-11-06T16:05:06.0202209+00:00",
        "umpCustomerGuid": "b11a3f8a-9220-457a-938f-cae531f79d67",
        "licenseSettingsFlagsLevel": 2,
        "LicenseFactors": {
            "Managed Users - By Template": true,
            "Managed Users - By User Interface": true,
            "Managed Service Numbers": true
        }
    }
]

HTTP Responses

■ 200 OK

Parameter

Type

Description

acquiredLicenses

integer

Number of licenses configured during the Onboarding wizard process.

totalMonitoredUsers

string

Number of monitored M365 users.

currentlyLicensed

integer

Total number of currently licensed users.

managedUsersDirectRouting

integer

Total number of users configured and assigned with Direct Routing numbers. Voice Routing Policy 'Unrestricted' is applied to the number.

managedUsersOperatorConnect

integer

Total number of users configured and assigned with Operator Connect numbers (number is assigned in customer tenant Teams admin center). Assigned Uploaded number Assignments:

■ UserAssigned
■ ConferenceAssigned
■ VoiceApplicationAssigned
■ ThirdPartyAppAssigned

managedUsersByLifeCycleManagement

integer

Total number of users assigned to a LifeCycle Management template.

managedUsersUserInterface

integer

Total number of users with User properties updated using this interface.

lastUpdate

string ($date-time)

Timestamp of the last update to user license.

UmpCustomerGuid

string($uuid)

Id value created in the Live Platformcustomer tenant SQL database directory:

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also obtained in the 'Get Task' response when the customer is created.

licenseSettingsFlagsLevel

integer

Default: 0

Global: 1

Customer: 2

Indicates whether the following license factors have been customized to include or exclude from the license factor calculation:

■ Managed Users-By Template
■ Managed Users-By User Interface
■ Managed Service Numbers

One of the following values:

■ Default: The above license factors are by default included in the license calculation
■ Global: The above license factors have been configured by SysAdmin for inclusion or exclusion.
■ Customer: The above license factors have been configured by the Customer for inclusion or exclusion.

LicenseFactors

boolean

License factors that can be configured globally by Service Provider or overridden by the service configuration. One of the following:

■ Managed Users - By LifeCycle Management
■ Managed Users - By User Interface
■ Managed Service Numbers

See Managing User Licenses for details.
■ 404 Not Found

The table below shows the full list of fields returned in this response. The actual fields returned may differ according to the request.

Parameter

Type

Description

type

string

Error type

title

string

Email title

status

integer

The status of the connection with M365 platform:

■ 0-Active
■ 1-Not Active
■ 2-OC Essential

detail

string

Additional error details.

instance

string

Error instance.

errorTicket

string

The error ticket string opened for this request.

errorCode

string

Error code output in the request

traceId

string

The trace id of the request

additionalProp1

string

Custom Script variable argument. For example IP-Network.

additionalProp2

string

Custom Script argument. For example, IP-SubnetBits.

additionalProp3

string

Custom Script argument. For example, Trusted-IP-Network.
■ 500 Internal Server Error